Client device using a markup language to control a periphery device via a point-of-sale printer

ABSTRACT

A device control system has a terminal  3  with an application  31 , and a printer  5  that controls a device. The terminal  3  sends a request written in XML generated by the application  31 . The printer  5  receives the XML request, the terminal  3  sends an XML response, and if the terminal  3  requested control of the device in the XML request, controls the device.

CROSS-REFERENCE TO RELATED APPLICATIONS

This application is a continuation of, and claims priority under 35U.S.C. §120 on, application Ser. No. 14/140,301, filed Dec. 24, 2013,which claims priority under 35 U.S.C. §119(e) on provisional applicationNo. 61/748,232, filed Jan. 2, 2013. The content of each such relatedapplication is incorporated by reference herein in its entirety.

TECHNICAL FIELD

The present invention relates to a device control system that controls adevice, and a control method of the device control system.

BACKGROUND

A device (such as a computer) used as a controller for controllingdevices is conventionally part of a system that controls devices such asa keyboard and barcode scanner by means of a terminal connected to anetwork.

CITATION LIST Patent Literature

[PTL 1] JP-A-2004-152256

SUMMARY OF INVENTION Technical Problem

However, there is also a need to use devices such as above by means of asimple configuration.

The present invention is directed to the foregoing problem, and anobject of the invention is to provide a device control system, aterminal, and a control method of a device control system that cancontrol devices by a terminal connected to a network.

Solution to Problem

To achieve the foregoing object, a device control system according tothe invention has a device configured to input or output data; aterminal configured to run an application, to send a request in markuplanguage and to receive a response in markup language; and a devicecontrol device configured to connect to the device, to control thedevice based on the markup language request, and to send the markuplanguage response.

The invention enables controlling devices connected to the devicecontrol device by a terminal connected to a network. The terminal can beany device that can run an application that generates data written inXML. Because XML is highly versatile, many different devices can be usedas the terminal. Developing applications for the terminal is alsosimple.

In addition, the response includes data denoting the result ofcontrolling the device.

The application also sends to the device control device the requestincluding an establish communication message requesting establishing acommunication link to the device control device; and when the requestincluding the establish communication message is received, the devicecontrol device sends to the application the response including aresponse message to the establish communication message contained in therequest.

The application also establishes a communication link with the devicecontrol device based on a response message to the establishcommunication message contained in the response sent by the devicecontrol device.

After the communication link is established, the application also sendsto the device control device the request including an open message toopen communication to the device connected to the device control deviceto the device control device.

When the request containing the open message is received, the devicecontrol device sends to the application the response including aresponse message to the open message contained in the request.

The application also receives the response containing a response messageto the open message sent by the device control device, and based on aresponse message to the open message becomes able to communicate withthe device.

After communication with the device is enabled, the application alsosends to the device control device the request including a close messageto close communication with the device.

The device control device also receives the request containing the closemessage, and sends to the application the response containing a responsemessage to the close message.

In addition, the application receives the response containing a responsemessage to the close message sent by the device control device, andcloses communication with the device based on a response message to theclose message.

Another aspect of the invention is a control method of a device controlsystem including a device configured to input or output data, a terminalconfigured to run an application, and a device control device configuredto connect to the device, comprising: sending a markup language requestgenerated by the application to the device control device; and receivingthe request by the device control device; generating a response in themarkup language; and sending the generated response to the terminal.

The control method of a device control system also includes, sendinginformation contained in the request to the device by the device controldevice; executing a process based on information contained in therequest by the device, and sending a result processed based oninformation contained in the request to the device control device; andsending to the terminal the response including a result processed basedon information contained in the request sent by the device.

The control method of a device control system also includes theapplication sending to the device control device the request includingan establish communication message requesting establishing acommunication link to the device control device; and when the requestincluding the establish communication message is received, the devicecontrol device sending to the application the response including aresponse message to the establish communication message contained in therequest.

In addition, the application establishes a communication link with thedevice control device based on a response message to the establishcommunication message contained in the response sent by the devicecontrol device.

In addition, after the communication link is established, theapplication sends to the device control device the request including anopen message to open communication to the device connected to the devicecontrol device to the device control device.

In addition, when the request containing the open message is received,the device control device sends to the application the responseincluding a response message to the open message contained in therequest.

In addition, the application receives the response containing a responsemessage to the open message sent by the device control device; and basedon a response message to the open message becomes able to communicatewith the device.

In addition, the application sends to the device control device therequest including a close message to close communication with the devicewhen stopping the application after communication between theapplication and the device is enabled.

In addition, the device control device receives the request containingthe close message, and sends to the application the response containinga response message to the close message.

In addition, the application receives the response containing a responsemessage to the close message sent by the device control device, andcloses communication with the device based on a response message to theclose message.

Objects of the present invention are also met in a printer for apoint-of-sale (POS) system. The printer includes: a connector configuredto connect to a device responsive to device-control commands; acommunication interface configured to communicate with a terminal, toreceive a markup language request from the terminal, and to send amarkup language response to the terminal; a controller configured tointerpret the markup language request received from the terminal, and tocontrol the device using appropriate device-control commands to executethe interpreted markup language request, the printer being furtherconfigured to encode any response from the device as a markup languageresponse and to send the markup language response to the terminal;wherein the device-control commands are not a markup language.

Preferably, the markup language response includes data denoting a resultof device control.

Additionally, the printer may also receive, from the terminal, anestablish communication markup language request to establishment acommunication link with the printer. In this case, the printer may send,to the terminal, a markup language response to the establishcommunication markup language request.

Further preferably, in response to the printer receiving from theterminal an open markup language request to open communication with thedevice connected to the printer, the printer sends to the terminal amarkup language response to the open markup language request indicatingwhether a communication link with the device is established.

Furthermore, in response to the printer receiving from the terminal aclose markup language request to close communication with the device,the printer sends to the terminal a markup language response to theclose markup language request indicating whether communication with thedevice is closed.

In the above, the communication interface is preferably a computernetwork interface.

BRIEF DESCRIPTION OF DRAWINGS

FIG. 1 illustrates a device control system according to a preferredembodiment of the invention.

FIG. 2 shows the functional configuration of the device control system.

FIG. 3A shows a list of key codes that can be acquired from a keyboard.

FIG. 3B shows a list of key codes that can be acquired from a keyboard.

FIG. 4 shows an example of device connections to an intelligent printer.

FIG. 5 is an external oblique view of an intelligent printer.

FIG. 6 shows a connector panel.

FIG. 7 shows an example of a wireless LAN unit connection.

FIG. 8 shows the work flow of building a system environment.

FIG. 9 shows a method of registering a device control script.

FIG. 10 shows a method of registering a controlled device.

FIG. 11 shows a list of the types of registered devices.

FIG. 12 illustrates registration of a device.

FIG. 13 illustrates registration of a device.

FIG. 14 illustrates registration of a device.

FIG. 15 illustrates registration of a device.

FIG. 16 illustrates registration of a device.

FIG. 17 illustrates the basic programming sequence.

FIG. 18 shows the interface that is used.

FIG. 19A shows the data format.

FIG. 19B shows the data content.

FIG. 20A shows an example of communication data.

FIG. 20B shows an example of communication data.

FIG. 21 shows an example of the array of elements in a message.

FIG. 22 shows messages.

FIG. 23 shows message data for each device.

FIG. 24A illustrates an <admin_info> message.

FIG. 24B illustrates an <admin_info> message.

FIG. 24C illustrates an <admin_info> message.

FIG. 24D illustrates an <admin_info> message.

FIG. 24E illustrates an <admin_info> message.

FIG. 25A illustrates an <open_device> message.

FIG. 25B illustrates an <open_device> message.

FIG. 25C illustrates an <open_device> message.

FIG. 25D illustrates an <open_device> message.

FIG. 25E illustrates an <open_device> message.

FIG. 25F illustrates an <open_device> message.

FIG. 26A illustrates a <close_device> message.

FIG. 26B illustrates a <close_device> message.

FIG. 26C illustrates a <close_device> message.

FIG. 26D illustrates a <close_device> message.

FIG. 26E illustrates a <close_device> message.

FIG. 27A illustrates a <device_data> message.

FIG. 27B illustrates a <device_data> message.

FIG. 27C illustrates a <device_data> message.

FIG. 27D illustrates a <device_data> message.

FIG. 28A illustrates an <error> message.

FIG. 28B illustrates an <error> message.

FIG. 28C illustrates an <error> message.

FIG. 29A illustrates a message for a barcode scanner.

FIG. 29B illustrates a message for a barcode scanner.

FIG. 29C illustrates a message for a barcode scanner.

FIG. 30A illustrates a message for a printer.

FIG. 30B illustrates a message for a printer.

FIG. 31A illustrates a message for a printer.

FIG. 31B illustrates a message for a printer.

FIG. 32A illustrates an XML document for printer control.

FIG. 32B illustrates an XML document for printer control.

FIG. 33A illustrates an XML document for printer control.

FIG. 33B illustrates an XML document for printer control.

FIG. 33C illustrates an XML document for printer control.

FIG. 33D illustrates an XML document for printer control.

FIG. 34A illustrates an XML document for printer control.

FIG. 34B illustrates an XML document for printer control.

FIG. 34C illustrates an XML document for printer control.

FIG. 34D illustrates an XML document for printer control.

FIG. 34E illustrates an XML document for printer control.

FIG. 34F illustrates an XML document for printer control.

FIG. 34G illustrates an XML document for printer control.

FIG. 34H illustrates an XML document for printer control.

FIG. 34I illustrates an XML document for printer control.

FIG. 34J illustrates an XML document for printer control.

FIG. 34K illustrates an XML document for printer control.

FIG. 34L illustrates an XML document for printer control.

FIG. 34M illustrates an XML document for printer control.

FIG. 34N illustrates an XML document for printer control.

FIG. 34P illustrates an XML document for printer control.

FIG. 35 illustrates an XML document for printer control.

FIG. 36A illustrates an XML document for printer control.

FIG. 36B illustrates an XML document for printer control.

FIG. 36C illustrates an XML document for printer control.

FIG. 36D illustrates an XML document for printer control.

FIG. 37A illustrates an XML document for printer control.

FIG. 37B illustrates an XML document for printer control.

FIG. 38A illustrates an XML document for printer control.

FIG. 38B illustrates an XML document for printer control.

FIG. 38C illustrates an XML document for printer control.

FIG. 38D illustrates an XML document for printer control.

FIG. 38E illustrates an XML document for printer control.

FIG. 38F illustrates an XML document for printer control.

FIG. 38G illustrates an XML document for printer control.

FIG. 38H illustrates an XML document for printer control.

FIG. 38I illustrates an XML document for printer control.

FIG. 38J illustrates an XML document for printer control.

FIG. 39A illustrates an XML document for printer control.

FIG. 39B illustrates an XML document for printer control.

FIG. 39C illustrates an XML document for printer control.

FIG. 39D illustrates an XML document for printer control.

FIG. 39E illustrates an XML document for printer control.

FIG. 39F illustrates an XML document for printer control.

FIG. 39G illustrates an XML document for printer control.

FIG. 39H illustrates an XML document for printer control.

FIG. 39I illustrates an XML document for printer control.

FIG. 39J illustrates an XML document for printer control.

FIG. 39K illustrates an XML document for printer control.

FIG. 40A illustrates an XML document for printer control.

FIG. 40B illustrates an XML document for printer control.

FIG. 41A illustrates an XML document for printer control.

FIG. 41B illustrates an XML document for printer control.

FIG. 42A illustrates an XML document for printer control.

FIG. 42B illustrates an XML document for printer control.

FIG. 43A illustrates an XML document for printer control.

FIG. 43B illustrates an XML document for printer control.

FIG. 44A illustrates an XML document for printer control.

FIG. 44B illustrates an XML document for printer control.

FIG. 45A illustrates an XML document for printer control.

FIG. 45B illustrates an XML document for printer control.

FIG. 46 illustrates an XML document for printer control.

FIG. 47A illustrates an XML document for printer control.

FIG. 47B illustrates an XML document for printer control.

FIG. 48A illustrates an XML document for printer control.

FIG. 48B illustrates an XML document for printer control.

FIG. 49A illustrates an XML document for printer control.

FIG. 49B illustrates an XML document for printer control.

FIG. 50A illustrates an XML document for printer control.

FIG. 50B illustrates an XML document for printer control.

FIG. 50C illustrates an XML document for printer control.

FIG. 51A illustrates an XML document for printer control.

FIG. 51B illustrates an XML document for printer control.

FIG. 51C illustrates an XML document for printer control.

FIG. 52A illustrates a message for a customer display.

FIG. 52B illustrates a message for a customer display.

FIG. 53A illustrates a message for a customer display.

FIG. 53B illustrates a message for a customer display.

FIG. 54A illustrates an XML document for customer display control.

FIG. 54B illustrates an XML document for customer display control.

FIG. 55A illustrates an XML document for customer display control.

FIG. 55B illustrates an XML document for customer display control.

FIG. 55C illustrates an XML document for customer display control.

FIG. 56 illustrates an XML document for customer display control.

FIG. 57A illustrates an XML document for customer display control.

FIG. 57B illustrates an XML document for customer display control.

FIG. 57C illustrates an XML document for customer display control.

FIG. 57D illustrates an XML document for customer display control.

FIG. 58A illustrates an XML document for customer display control.

FIG. 58B illustrates an XML document for customer display control.

FIG. 58C illustrates an XML document for customer display control.

FIG. 59A illustrates an XML document for customer display control.

FIG. 59B illustrates an XML document for customer display control.

FIG. 59C illustrates an XML document for customer display control.

FIG. 60A illustrates an XML document for customer display control.

FIG. 60B illustrates an XML document for customer display control.

FIG. 61A illustrates an XML document for customer display control.

FIG. 61B illustrates an XML document for customer display control.

FIG. 62A illustrates an XML document for customer display control.

FIG. 62B illustrates an XML document for customer display control.

FIG. 62C illustrates an XML document for customer display control.

FIG. 62D illustrates an XML document for customer display control.

FIG. 62E illustrates an XML document for customer display control.

FIG. 62F illustrates an XML document for customer display control.

FIG. 63 illustrates an XML document for customer display control.

FIG. 64 illustrates an XML document for customer display control.

FIG. 65 illustrates an XML document for customer display control.

FIG. 66 illustrates an XML document for customer display control.

FIG. 67A illustrates a message for a POS keyboard.

FIG. 67B illustrates a message for a POS keyboard.

FIG. 67C illustrates a message for a POS keyboard.

FIG. 68A illustrates a message for a POS keyboard.

FIG. 68B illustrates a message for a POS keyboard.

FIG. 69A illustrates a message for a POS keyboard.

FIG. 69B illustrates a message for a POS keyboard.

FIG. 69C illustrates a message for a POS keyboard.

FIG. 70A illustrates a message for a serial communication device.

FIG. 70B illustrates a message for a serial communication device.

FIG. 71A illustrates a message for a serial communication device.

FIG. 71B illustrates a message for a serial communication device.

FIG. 71C illustrates a message for a serial communication device.

FIG. 72 illustrates a device control script.

FIG. 73 illustrates a device control script.

FIG. 74 illustrates a device control script.

FIG. 75 illustrates a device control script.

FIG. 76 illustrates a device control script.

FIG. 77 illustrates a device control script.

FIG. 78 illustrates a device control script.

FIG. 79 illustrates a device control script.

FIG. 80 illustrates a device control script.

FIG. 81 illustrates a device control script.

FIG. 82 illustrates a sample program.

FIG. 83 illustrates the flow of constructing the environment of thesample program.

FIG. 84A illustrates the flow of constructing the environment of thesample program.

FIG. 84B illustrates the flow of constructing the environment of thesample program.

DESCRIPTION OF EMBODIMENTS

A preferred embodiment of the invention is described below withreference to the accompanying figures.

FIG. 1 shows the configuration of a device control system 100 accordingto the invention. This device control system 100 includes a terminal 3and a printer 5 (intelligent printer).

The terminal 3 may be any device that connects to a network and iscapable of socket communication, and could be a personal computer, asmartphone, or a tablet computer, for example. The terminal 3 has anenvironment that is capable of socket communication and can handle XMLdocuments, which are markup language, and uses iOS, Android, Windows,Linux, or MacOS, for example, as the OS (operating system).

The terminal 3 and printer 5 are connected over a communication network.In the example shown in FIG. 1, the device control system 100 has awireless LAN access point 11, and the wireless LAN access point 11 isconnected to the printer 5 by a cable. The terminal 3 and printer 5communicate by a wireless connection between the terminal 3 and thewireless LAN access point 11.

A network printer 7, customer display 8, and barcode scanner 9 areconnected to the printer 5 as controlled devices. The network printer 7is connected to the printer 5 through a network. The network printer 7is a printer separate from the local printer 55 (FIG. 2) of the printer5, and has a wired LAN or wireless LAN interface. The customer display 8is connected through the USB interface described below. The barcodescanner 9 is connected through the USB interface described below. Thesedevices are generally called peripheral devices (peripherals), and arereferred to below as devices. Devices that connect to the printer 5 arenot limited to the devices shown in FIG. 1. For example, displays, andkey input devices such as keyboards are also included. Also included aredevices that can be controlled by a HID (human interface device) driverstandard to the OS, serial communication devices that can be operatedusing a serial communication driver standard to the OS, and USB devicesthat can be controlled in the same way as serial communication devices.

Operation of the device control system 100 is described next.

(1) Place an application on the terminal 3.

(2) The application sends a request message to the printer 5.

(3) The printer 5 sends data to a device that can be controlled from theprinter 5.

(4) The network printer and devices connected to the printer 5 arecontrolled.

(5) The printer 5 returns a response to the terminal 3.

FIG. 2 illustrates the functional configuration of the device controlsystem 100.

The device control system 100 uses Device XML, which is a command systemwritten in XML markup language defining functions for controllingdevices (peripheral devices) connected to the printer 5.

The terminal 3 has an application 31. The application 31 is a nativeapplication program installed on the terminal 3. The application 31, thedevice application programming interface (API) 33, sends an XML formatrequest message (Request) by socket communication to the printer 5.

A device service interface 501 and a device control script 502 are builtin to the printer 5. The device service interface 501 and device controlscript 502 interpret the request message, and output a request to thedevice control script 502. The device control script 502 controls a keyinput device 18 and serial communication device 19. The device controlscript 502 outputs key input device 18 and serial communication device19 events and control result responses to the device service interface501. The key input device 18 in this example includes the keyboard 14 inFIG. 1, and the serial communication devices 19 include the barcodescanner 9 and cash drawer 13 in FIG. 1.

The device service interface 501 exchanges data with the local printer55. The local printer 55 is the printer incorporated in the printer 5.The device service interface 501 also exchanges data with the networkprinter 7 and customer display 8.

The device service interface 501 outputs an XML format response(Response) to the application 31 based on the results of controlling thenetwork printer 7, customer display 8, and local printer 55, and devicecontrol script 502 responses.

The printer 5 thus controls devices through the device service interface501 and device control script 502. Devices controlled in the exampleshown in FIG. 2 are the network printer 7, customer display 8, key inputdevice 18, serial communication device 19, and local printer 55.

The terminal 3 can control devices connected to the printer 5 using theDevice XML command system of the device control system 100 by the aboveoperation.

Device XML has the following features.

-   -   A separate device (such as a computer) used as a controller is        not needed to control devices.    -   Devices that operate according to a driver standard to the OS of        the printer 5 can be used through the device control script 502        without installing a specific driver.    -   When a device is accessed, the device is exclusively locked.        Multiple terminals 3 therefore cannot access and control a        device at the same time. When the terminal 3 controlling a        device releases the device, the device can then be controlled        from another terminal 3.

The device API 33 has the following features.

-   -   Commands that print lines can be used when the network printer 7        or the local printer 55 of the printer 5 supports a line        command.    -   Buzzer functions can be used when a buzzer is connected to the        printer 5 or network printer 7.    -   Key codes that can be acquired from the keyboard 14 are limited.        Key codes that can be acquired from the keyboard 14 are shown in        FIG. 3A and FIG. 3B.

The configuration of the printer 5 is described next.

The printer 5 has a CPU, RAM, flash ROM, nonvolatile memory, a videocontroller, an auxiliary storage device (SSD: solid state drive),interface, and a local printer (print unit). The printer 5 could alsohave a speaker. The local printer is a thermal printer that can print on80 mm wide or 58 mm wide roll paper.

The printer 5 can be installed in a POS (point of sale) system. Theoperating system (OS) of the printer 5 is Windows® based, for example,and is stored in the auxiliary storage device.

A device control program, which is software for the terminal 3 tocontrol devices connected to the printer 5, is installed to the printer5. As a result, installing a driver program to the terminal 3 is notnecessary.

The printer 5 also has a Windows® standard device driver program (APD),UPOS driver, OPOS driver, or other software for controlling devices andthe local printer of the printer 5.

A web application can be installed to the printer 5. This enables usingthe printer 5 as an application server as shown in FIG. 3. The webapplication could, for example, be a PHP and Perl server-side script orSQLite database access script (server-side script).

FIG. 4 shows an example of device connections to the printer 5.

The foregoing network printer 7, customer display 8, and barcode scanner9 can be connected to the printer 5. A display 12, cash drawer 13, andkeyboard 14 can be connected to the printer 5.

FIG. 5 shows the external appearance of the printer 5.

A roll paper cover 51 is disposed to the top of the printer 5. The rollpaper cover opens when the cover open button 52 is pressed, and rollpaper can be loaded. A manual cutter 53 for manually cutting the rollpaper, and a cutter cover 54, are disposed to the paper exit from whichthe roll paper is discharged after printing. The cutter cover 54 isopened when a paper jam occurs in the local printer of the printer 5,and when the roll paper cover 51 does not open. The blade of the manualcutter 53 returns to the home position when the cutter cover 54 opens.The printer 5 also has a power switch 56B, reset button 56A, LED displayunit 57, and control panel 58. The LED display unit 57 includes a discaccess LED indicating accessing the auxiliary storage device, and statusLEDs. The status LEDs report the operating state of the OS, the standbymode of the OS, that the power is off, the OS start-up sequence, and ahigh CPU temperature warning.

The control panel 58 includes a power LED, error LED, roll paper LED,and paper feed button. The power LED lights when power is supplied. Theerror LED is off during normal operation, and lights when the printerresets and when the end of the roll paper is detected and printingstops. The paper LED is off when sufficient roll paper remains, lightssteady when little paper is left, and blinks when the self-diagnostictest is running. Pressing the feed button advances the roll paper oneline at a time or continuously.

A connector cover 59 is disposed to the back of the printer 5. Removingthe connector cover 59 exposes the connector panel (connection panel) onthe back of the printer 5.

FIG. 6 shows the connection panel 60. The connection panel 60 includes adrawer kick-out connector 61, Ethernet connector 62, USB connector 63,VGA connector 64, COM connector 65, line output 66, and DC input 67. Theconnection panel 60 is the connection unit of the accompanying claims.However, the local printer 55 built into the printer 5 is also one ofthe devices connected to the printer 5. The connection unit thereforeincludes the connection panel 60 and an internal interface of theprinter 5.

The cash drawer 13 or an optional buzzer is connected to the drawerkick-out connector 61. The Ethernet connector 62 is connected to thenetwork. The USB connector 63 has six USB ports. The customer display 8,barcode scanner 9, keyboard 14, and other devices are connected to theUSB connector 63. The display 12 is connected to the VGA connector 64.The serial interface of a serial communication device connects to theCOM connector 65. The line output 66 connects to an external speaker.

FIG. 7 illustrates connection of a wireless LAN unit 17. The wirelessLAN unit 17 plugs into a USB extension cable 15, and the USB extensioncable 15 plugs into the USB connector 63. The printer 5 can thus beconnected to a wireless LAN.

Building a device service interface 501 environment is described next.

FIG. 8 shows the flow of work when building the environment.

1. Network Settings

Configure the system and printer 5 network. The network settings of theprinter 5 can be configured using any of the following methods.

-   -   Configuring the Windows® network settings on the printer 5.    -   Installing the TMNet WinConfig utility, which is an application        for configuring the printer 5, on an external device (a Windows        computer).

2. Connect a Device to the Printer 5

Connect a device to the printer 5. As described above, connectabledevices include the customer display 8, barcode scanner 9, display 12,cash drawer 13, and keyboard 14. Also included are devices that can becontrolled by a HID driver standard to the OS, serial communicationdevices that can be operated using a serial communication driverstandard to the OS, and USB devices that can be controlled in the sameway as serial communication devices. The connection panel 60 in FIG. 6has only one COM connector 65, but plural serial communication devicescan be connected if a serial-USB conversion cable is used and the driverprogram is compatible with serial-USB conversions.

3. Register Device Control Script

A device control script prepared by the user is registered in order forthe printer 5 to control devices other than the products with which theprinter 5 is compatible. Registration is done from the web browser.

4. Register Device

Register the device connected to the printer 5 in the printer 5software. Registration is done from the web browser.

The web browser used for steps 1 to 5 includes a web browser that runson the terminal 3.

A method of registering a device control script prepared by the user isdescribed with reference to FIG. 9.

The registration steps are as follow.

(1) Prepare a customized device control script.

(2) Turn the printer 5 power on.

(3) Start the web browser, and input the URL (http://IP address ofprinter 5/WebConfig/).

(4) Start the TMNetWebConfig utility. Click on [Web servicesettings]-[Register/delete] in the window shown in FIG. 9.

(5) The Control Script screen is displayed.

Click on [Browse] in the Control script to be registered field, andselect the device control script to register.

(6) Click [Registration].

The device control script is registered and listed in the Registeredcontrol scripts field in the bottom of the window.

Register a device to be controlled by Device XML. A device is registeredby the web browser displaying the TMNetWebConfig utility as shown inFIG. 10.

The registration steps are as follow.

(1) Start the web browser, and input the URL (http://IP address ofprinter 5/WebConfig/).

(2) TheTMNetWebConfig utility starts. From [Web servicesettings]-[Device registration] in the window shown in FIG. 10, click onthe type of device to register. Devices are displayed under Deviceregistration in the screen shown in FIG. 10. Click on the type of deviceto register. The type of device in this embodiment can be selected fromfive types, printer, display, key input device, serial communicationdevice, and other as shown in FIG. 11. Details about the types ofdevices are as shown in FIG. 11.

(3) A configuration screen is displayed for each device. The connecteddevice is registered in the printer 5.

(3-1) To register a printer

Confirm registration of the local printer incorporated in the printer 5as follows.

(3-1-1) Check that “printer 5” is registered for the device ID “localprinter” in the Registered Printer field in the screen shown in FIG. 10.

(3-1-2) Click on [Test printing]. Check that TEST_PRINT is printed bythe local printer 55.

(3-1-3) Register the connected network printer 7.

Register the network printer 7 by the following steps.

(3-1-3-1) Set the items shown in FIG. 12 (device ID, type, model number,IP address, retry interval), and click [Registration].

(3-1-3-2) After confirming the printer is added to the RegisteredPrinter list, click [Test printing]. Confirm that TEST_PRINT is printedby the registered network printer 7.

(3-2) To register a display (customer display 8)

The device ID of the customer display is a constant, “local display”.Register the connected customer display 8 by the following steps.

(3-2-1) Select “Use” in the screen shown in FIG. 10.

(3-2-2) Set the items (communication settings, brightness settings) inFIG. 13, and click [Registration].

(3-2-3) Click [Test display]. Confirm that text is displayed on thecustomer display 8.

(3-3) To register a key input device 18

Register the connected key input device 18 by the following steps.

(3-3-1) Set the items (device ID, device name, control script) in FIG.14, and click [Registration].

(3-3-2) After confirming the registered device was added to theRegistered Key Input Device field, click [Operating test].

(3-3-3) A screen will be displayed by the web browser. Operate the keyinput device 18, and confirm that the result is displayed as operated.

(3-4) To register a serial communication device 19

Register the connected serial communication device 19 by the followingsteps.

(3-4-1) Set the items (device ID, device name, control script,communication speed, data bit, parity, stop bit, free control) shown inFIG. 15 for the connected serial communication device 19, and click[Registration].

(3-4-2) Confirm that the device is added to the Registered SerialCommunication Device field.

(3-5) To register another device

Register another connected device by the following steps.

(3-5-1) Set the items (device ID, control script) shown in FIG. 16 forthe connected device, and click [Registration].

(3-5-2) Confirm that the device is added to the Registered Other Devicesfield.

The programming method for developing an application using Device XML isdescribed next.

The basic sequence of programming in Device XML is shown in FIG. 17.

Applications in FIG. 17 corresponds to application 31, Device Controlindicates the device control function (device service interface 501),and Device denotes a controlled device.

1: Establish TCP connection. Establish a TCP connection to the socketinterface from the application 31.

2: Connect message. Establish a communication path to the device serviceinterface 501.

3: The application 31 sends an open_device message (type_printer).

3.1: Device service interface 501 sends a Cmd( ) command to device.

4: Device returns “Device open”.

4.1: Device service interface 501 returns response.

6: Application 31 sends a device_data_message. Application 31 controlsdevice using the device_data_message.

6.1: Cmd( ) command sent to device.

6.1.1: Device executes.

Device sends response to device_data_message.

7.: Device returns the execution result.

7.1: Device service interface 501 returns a device_data_message or errormessage.

8: Application 31 sends close_device_nmessage. The connection to thedevice service interface 501 and socket interface communication isterminated.

8.1: Device service interface 501 sends a Cmd( ) command to device.

9: Device closes.

9.1: Device service interface 501 returns response to application 31.

The interface shown in FIG. 18 is used to control devices using DeviceXML.

The format of each data item is as shown in FIG. 19A, and FIG. 19B showsa description of each data item.

Examples of communication data between the application 31 and the deviceservice interface 501 are shown in FIG. 20A and FIG. 20B. In FIG. 20Aand FIG. 20B, the NULL character is represented by “¥0”. FIG. 20A andFIG. 20B show examples of communication data when establishing aconnection, acquiring administrator information, opening a device,controlling a device, and closing a device.

The method of creating an array of <data> elements in a <device_data>message is described next.

The following programming method is used to describe an array in the<data> tag:

-   -   Set the attribute array=“true” in the first element in the        array.    -   Then specify the value of each additional array element using        the same name for each element.

FIG. 21 shows sample code to create the array keycodes=[49, 50, 51, 52].

Device XML is described next. An ePOS-Device XML List is shown.

The following are included in ePOS-Device XML.

-   -   Message (FIG. 22)

This is XML for request messages from the application 31 to the printer5, and response messages from the printer 5 to the application 31.

-   -   Message data for each device (FIG. 23)

This is XML for storing request and response data for each controlleddevice. This forms a sub-element of the <data> element of a<device_data> message.

Message data for each device is described next.

Message data for each device specifies the data that controls the devicein a sub-element of the <data> element of a <device_data> message.

The component elements of the message data differ according to thedevice type.

Before specifying the data, declare the type of message data using the<type> element and then specify the data of the sub-element. The <type>elements that can be used for each type of device are shown in FIG. 23.

Messages are described next.

<connect>

This message is contained in a [Response].

This message returns to the application that a connection wasestablished.

The application 31 sends a message described below triggered byreceiving this message.

[Example]

<connect></connect>

<admin_info>

Returns the administrator information set in the printer 5. Theinformation is set with the TMNet WebConfig utility.

This message is contained in a [Request].

This message requests administrator information from the printer 5.

[Example]

<admin_info></admin_info>

This message is contained in a [Response].

This message returns the administrator information to the application31. A description of the sub-elements and data types is shown in FIG.24A.

-   -   code

FIG. 24B shows the code elements.

-   -   data

FIG. 24C shows the data elements.

Character strings in the received data are described next. The stringsshown in FIG. 24D are escaped.

[Example] FIG. 24E shows examples of normal and error responses.

<open_device>

This message makes the device linked to the device ID usable. Exclusiveuse of the specified device is given to the requesting application 31.

This message is contained in a [Request].

This message specifies the device to open. A description of thesub-elements and data types is shown in FIG. 25A.

-   -   data

FIG. 25B shows the data elements.

[Example] FIG. 25C shows an example of a request.

This message is contained in a [Response].

This message returns the device open result to the application 31. Adescription of the sub-elements and data types is shown in FIG. 25D.

-   -   code

FIG. 25E shows the code elements.

[Example] FIG. 25F shows examples of normal and error responses.

<close_device>

This message closes an opened device.

This message is contained in a [Request].

This message specifies the device to close. A description of thesub-elements and data types is shown in FIG. 26A.

[Example] FIG. 26B shows an example of a request.

This message is contained in a [Response].

This message returns the device close result to the application 31. Adescription of the sub-elements and data types is shown in FIG. 26C.

-   -   code

FIG. 26D shows the code elements.

[Example] FIG. 26E shows examples of normal and error responses.

<device_data>

This message is contained in a [Request].

This message sends data to a device. Device control commands, and printand display data are included. A description of the sub-elements anddata types is shown in FIG. 27A.

[Example] FIG. 27B shows an example of a request.

This message is contained in a [Response].

This message returns data from the device. The result of device control,events that occurred in the device, and input data from the device areincluded. A description of the sub-elements and data types is shown inFIG. 27C.

[Example] FIG. 27D shows an example of a response.

<error>

This message is contained in a [Response].

This message returns device control command and service control commanderrors, and other common errors. A description of the sub-elements anddata types is shown in FIG. 28A.

-   -   code

FIG. 28B shows the code elements.

[Example] FIG. 28C shows an example of a response.

Message data for the barcode scanner is described next.

<type>ondata</type>

This message is contained in a [Response].

This message returns scanned data from the barcode scanner to theapplication. A description of the sub-elements and data types is shownin FIG. 29A.

Character strings in the received data are described next. The stringsshown in FIG. 29B are escaped.

[Example] FIG. 29C shows an example of a response.

Message data for the printer is described next.

Print data is described below in Printer Control XML.

<type>print</type>

This message is contained in a [Request].

This message sends print data and settings data to the printer. Adescription of the sub-elements and data types is shown in FIG. 30A.

[Example] FIG. 30B shows an example of a request.

<type>onxmlresult</type>

This message is contained in a [Response].

This message returns the print result to the application. A descriptionof the sub-elements and data types is shown in FIG. 31A.

[Example] FIG. 31B shows an example of a response.

Printer Control XML, which is an XML document that controls a printer,is described next.

Message data for a printer is described below under Message Data forPrinters.

<epos-print>

This is an XML document sent from an application to a printer. Thisdocument instructs the printer to execute a specified function.<epos-print> contains the element.

[Attribute]

-   -   xmlns

This attribute declares the epos-print name.

[Sub-elements] FIG. 32A shows the sub-elements.

[Example] FIG. 32B shows a sample XML document.

<response>

This is an XML document that is returned from the printer to theapplication.

[Attribute]

-   -   success

This attribute gets the display result. FIG. 33A shows the attributevalues.

-   -   code

This attribute gets the error code. FIG. 32B shows the attribute values.

-   -   status

This attribute gets an OR function as a decimal expression according tothe printer status. FIG. 32C shows the attribute values.

[Example] FIG. 33D shows a sample XML document.

<text>

This message specifies the character string to print. This message alsoconfigures string-related settings such as style, print position, andline feed space.

To print content other than text after printing text, execute a linefeed or paper feed.

In page mode, characters are printed from the current print positionreferenced to the baseline dot of the characters (printerspecifications, page 151).

[Entity Reference]

Horizontal tab, line feed, and other symbols required for printercontrol are written using the entity references shown in FIG. 34A.

[Attribute]

-   -   lang

This attribute specifies the language. FIG. 34B shows the attributevalues.

The printable character codes depend upon the specifications of theprinter.

-   -   font

This attribute specifies the character font. FIG. 34C shows theattribute values.

If Japanese is specified, characters can be printed using Shift JIScodes.

-   -   smooth

This attribute specifies smoothing. Text printing quality improves ifsmoothing is enabled. FIG. 34D shows the attribute values.

-   -   dw

This attribute specifies double-sized width. FIG. 34E shows theattribute values.

If the dw attribute and the width attribute are both specified in oneelement, the horizontal scale specified by the width attribute takesprecedence.

-   -   dh

This attribute specifies double-sized height. FIG. 34F shows theattribute values.

If the dh attribute and the height attribute are both specified in oneelement, the vertical scale specified by the height attribute takesprecedence.

-   -   width

This attribute specifies horizontal scaling. FIG. 34G shows theattribute values.

If the dw attribute and the width attribute are both specified in oneelement, the horizontal scale specified by the width attribute takesprecedence.

-   -   height

This attribute specifies vertical scaling. FIG. 34H shows the attributevalues.

If the dh attribute and the height attribute are both specified in oneelement, the vertical scale specified by the height attribute takesprecedence.

-   -   reverse

This attribute specifies inverting the black and white parts ofcharacters. FIG. 34I shows the attribute values.

-   -   ul

This attribute specifies underlining. FIG. 34J shows the attributevalues.

-   -   em

This attribute specifies emphasized printing. FIG. 34K shows theattribute values.

-   -   color

This attribute specifies the character color. FIG. 34L shows theattribute values.

-   -   x

(Default: “0”)

This attribute specifies the print start position of the characters indots.

In page mode this is the same as the horizontal print position specifiedby the position element, but the print position moves on the horizontalaxis.

-   -   align

This attribute specifies text alignment. FIG. 34M shows the attributevalues.

In the standard mode, the align attribute controls where the linestarts.

The align attribute set in this element also applies to the alignattribute of image, logo, barcode, and symbol elements.

-   -   rotate

This attribute specifies rotated printing of text. FIG. 34N shows theattribute values.

The rotate attribute is ignored in page mode.

In page mode, the print direction is set to right to left (right toleft) using the direction element to print text rotated 180 degrees.

The rotate attribute set in this element also applies to the rotateattribute of the barcode and symbol elements.

-   -   linespc

(Default: “30”)

This attribute specifies the paper feed distance for one line in dots.

[Example] FIG. 34P shows an example of settings for printing a string.

<feed>

This message specifies the paper feed distance. This message specifiesthe paper feed distance in dots or in lines. When the paper feed amountis not specified, the paper is fed one line (line feed). This messagealso sets the paper feed distance per line.

[Attributes]

-   -   unit

This attribute specifies the paper feed distance in dots.

-   -   line

This attribute specifies the paper feed distance in lines.

-   -   linespc

(Default: “30”)

This attribute specifies the paper feed distance per line in dots.

If the paper feed distance per line is 30 dots, a maximum paper feeddistance of 240 lines can be specified.

The paper feed distance is stored separately for the standard mode andthe page mode. Specifying the linespc attribute also affects the linespcattributes of the <text> and <feed> elements that follow.

[Example] FIG. 35 shows a sample XML document.

<image>

This message specifies raster bit image data. (Data typexs:base64Binary)

Raster graphics refer to data generated by horizontally scanning thepixels of an image starting from an origin at the top left corner of theimage.

Data is generated at 1 bit per pixel for two-tone images, and 4 bits perpixel for 16-tone images, starting from the most-significant bit of eachbyte. Zero padding is added so that scan data is in byte units for eachline.

To print a raster image at high speed, specify “left” for the alignattribute and specify a multiple of 8 that does not exceed the printerpaper width for the width attribute.

In page mode, raster images are printed from the current print positionreferenced to the bottom left dot of the raster image. The printposition does not move.

In page mode, set the print position so that raster images do not extendbeyond the print area.

-   -   Barcodes and two-dimensional symbols are printed as two-tone        images because scanning quality is affected when printed as        multiple-tone raster images.    -   Use the ePOS-Print XML generator tool or other user application        to create raster graphic bit-images. Note the following when        using a user application.    -   Two-tone images: Specify a multiple of 8 for the image width or        fill the missing bits with zeros.    -   16-tone image: Specify a multiple of 2 for the image width or        fill the missing bits with zeros.        [Attribute]    -   width

This attribute specifies the image width in dots.

-   -   height

This attribute specifies the image height in dots.

-   -   color

This attribute specifies the character color. FIG. 36A shows theattribute values.

-   -   align

This attribute specifies the print position. FIG. 36B shows theattribute values.

The align attribute set in this element also applies to the alignattribute in the text, logo, barcode, and symbol elements.

-   -   mode

(Option (option))

This attribute specifies the color mode. FIG. 36C shows the attributevalues.

[Example] FIG. 36D shows a sample XML document.

<logo>

This message specifies a logo registered in the NV memory of theprinter.

A logo must first be registered in the printer using a model-specificutility or logo registration utility (TMFLogo).

In page mode, logos are printed from the current print positionreferenced to the bottom left dot of the logo.

[Attribute]

-   -   key1

This attribute specifies the value of key code 1 set at the time of NVlogo registration.

-   -   key2

This attribute specifies the value of key code 2 set at the time of NVlogo registration. This attribute is required.

-   -   align

This attribute specifies the print position. FIG. 37A shows theattribute values.

The align attribute set in this element also applies to the alignattribute in the text, logo, barcode, and symbol elements.

[Example] FIG. 37B shows a sample XML document.

<barcode>

This message specifies barcode data as a character string.

A barcode will not be printed if the settings are not compliant with thebarcode standard, or if the barcode will be larger than the print areaof the printer.

In page mode, a barcode is printed from the current print positionreferenced to the bottom left dot of the barcode (not including theHRI).

[Barcode Types]

FIG. 38A, FIG. 38B, and FIG. 38C show barcode types that can bespecified.

FIG. 38D shows the escape sequences used to specify binary data thatcannot be represented by a character string.

[Attribute]

-   -   type

This attribute specifies the barcode type. FIG. 38E shows the attributevalues.

-   -   hri

This attribute specifies the HRI position. FIG. 38F shows the attributevalues.

-   -   font

This attribute specifies the HRI font. FIG. 38G shows the attributevalues.

-   -   width

(Default: “3”)

This attribute specifies the module width in dots. Specify an integerfrom 2 to 6.

-   -   height

(Default: “162”)

This attribute specifies the module height in dots.

-   -   align

This attribute specifies the print position. FIG. 38H shows theattribute values.

The align attribute set in this element also applies to the alignattribute in the text, image, logo, and symbol elements.

-   -   rotate

This attribute specifies rotated printing. FIG. 38I shows the attributevalues.

The rotate attribute set in this element also applies to the rotateattribute in the text and symbol elements.

[Example] FIG. 38J shows a sample XML document.

<symbol>

This message prints a two-dimensional symbol.

This message specifies the two-dimensional symbol as a character string.

A two-dimensional symbol will not be printed if the settings are notcompliant with the two-dimensional symbol standard, or if thetwo-dimensional symbol will be larger than the print area of theprinter.

In page mode, a two-dimensional symbol is printed from the current printposition referenced to the bottom left dot of the two-dimensionalsymbol.

[Two-Dimensional Symbol Types]

FIG. 39A and FIG. 39B show two-dimensional symbol types that can bespecified.

FIG. 39C shows the escape sequences used to specify binary data thatcannot be represented by a character string.

[Attribute]

-   -   type

This attribute specifies the type of two-dimensional symbol. FIG. 39Dshows the attribute values.

-   -   level

This attribute specifies the error correction level. FIG. 39E shows theattribute values.

The error correction level is selected according to the type oftwo-dimensional symbol.

Select the default for MaxiCode and two-dimensional GS1 DataBar symbols.

-   -   width

This attribute specifies the width of one module in dots. FIG. 39F showsa description.

-   -   height

This attribute specifies the height of one module in dots. FIG. 39Gshows a description.

-   -   size

FIG. 39H shows a description.

-   -   align

This attribute specifies the print position. FIG. 39I shows theattribute values.

The align attribute set in this element also applies to the alignattribute in the text, image, logo, and barcode elements.

-   -   rotate

This attribute specifies rotated printing. FIG. 39J shows the attributevalues.

The rotate attribute set in this element also applies to the rotateattribute in the text and barcode elements.

[Example] FIG. 39K shows a sample XML document.

<hline>

This message specifies a horizontal line.

[Attribute]

-   -   x1

This attribute specifies the start position of the horizontal line (indots).

-   -   x2

This attribute specifies the end position of the horizontal line (indots).

-   -   style

(Option)

This attribute specifies the type of horizontal line. FIG. 40A shows theattribute values.

[Example] FIG. 40B shows a sample XML document.

<vline-begin>

This message starts drawing a vertical line.

This message cannot be used in page mode.

A vertical line is drawn until the end is specified by the <vline-end>message described below. This element is used with vline-end.

[Attribute]

-   -   x

This attribute specifies the start position of the vertical line (indots).

-   -   style

(Option)

This attribute specifies the type of vertical line. FIG. 41A showssample attributes.

[Example] FIG. 41B shows a sample XML document.

<vline-end>

This message stops drawing a vertical line.

This element is used with vline-begin described above.

[Attribute]

-   -   x

This attribute specifies the end position of the vertical line (indots).

-   -   style

(Optional)

This attribute specifies the type of vertical line. FIG. 42A showssample attributes.

[Example] FIG. 42B shows a sample XML document.

<page>

This message changes from the standard mode to the page mode.

[<page> elements]

The elements shown in FIG. 43A can be used in <page>.

[Example] FIG. 43B shows a sample XML document.

<area>

This message specifies the print area in page mode.

The print area is set by specifying the origin, width, and heightreferenced to the absolute origin. As shown in FIG. 44A, the absoluteorigin is a dot above the top left corner of the printable area.

Specify the print area according to the print content. If print dataextends beyond the print area, the print data will not be completelyprinted.

This element is used in a page element.

[Attribute]

-   -   x

(Default: “0”)

This attribute specifies the origin on the horizontal axis in dots.

-   -   y

(Default: “0”)

This attribute specifies the origin on the vertical axis in dots.

-   -   width

(Default: Varies according to type.)

This attribute specifies the width of the print area in dots.

-   -   height

(Default: Varies according to type.)

This attribute specifies the height of the print area in dots.

Specify the width and height of the print area according to the printdirection setting. The print data may not be completely printed.

[Example] FIG. 44B shows a sample XML document.

<direction>

This message specifies the print direction in page mode.

This message specifies the print direction and rotates the print area.The starting point of the print area moves according to the rotation ofthe print area.

This element is used in a page element.

[Attribute]

-   -   dir

This attribute specifies the direction of rotation. FIG. 45A shows theattribute values.

[Example] FIG. 45B shows a sample XML document.

<position>

This message specifies the print position in page mode.

This message specifies the print position referenced to the startingpoint of the print area. The starting point of the print area movesaccording to the direction of rotation.

This element is used in a page element.

[Attribute]

-   -   x

(Default: “0”)

This attribute specifies the horizontal position in dots.

-   -   y

(Default: “21”)

This attribute specifies the vertical position in dots.

This message specifies the print start position (coordinates) accordingto the content to be printed. Refer to the following.

-   -   To print a character string: Specify the left end of the        baseline of the first character.

This is optional when for left-aligned printing of standard-sizedcharacters. To print double-sized height characters, specify a valueequal to or greater than “42” for y.

-   -   To print a barcode:

Specify the bottom left of the symbol. Specify the barcode height for y.

-   -   To print a graphic/logo:

Specify the bottom left of the graphic data. Specify the height of thegraphic data for y.

-   -   To print a two-dimensional symbol:

Specify the top left of the symbol.

[Example] FIG. 46 shows a sample XML document.

<line>

This message draws a straight line in page mode.

Diagonal lines cannot be printed.

This element is used in a page element.

[Attribute]

-   -   x1

This attribute specifies the position (in dots) to start printing ahorizontal line.

-   -   y1

This attribute specifies the position (in dots) to start printing avertical line.

-   -   x2

This attribute specifies the position (in dots) to stop printing ahorizontal line.

-   -   y2

This attribute specifies the position (in dots) to stop printing avertical line. Specify the line type.

-   -   style

(Optional)

This attribute specifies the line type. FIG. 47A shows the attributevalues.

[Example] FIG. 47B shows a sample XML document.

<rectangle>

This message draws a rectangle in page mode.

This element is used in a page element.

In standard mode, Use the hline element, vline-begin element, andvline-end element are used.

[Attribute]

-   -   x1

This attribute specifies the position (in dots) to start printing ahorizontal line.

-   -   y1

This attribute specifies the position (in dots) to start printing avertical line.

-   -   x2

This attribute specifies the position (in dots) to stop printing ahorizontal line.

-   -   y2

This attribute specifies the position (in dots) to stop printing avertical line. Specify the line type.

-   -   style (Optional)

This attribute specifies the line type. FIG. 48A shows examples ofattributes.

[Example] FIG. 48B shows a sample XML document.

<cut>

This message specifies a paper cut.

This message is used in standard mode.

This message executes at the beginning of a line. The paper is at thebeginning of a line after the paper is cut.

[Attribute]

-   -   type

(Option)

This attribute specifies the type of cut. FIG. 49A shows examples ofattributes.

[Example] FIG. 49B shows a sample XML document.

<pulse>

This message specifies outputting a signal to the drawer kick-outconnector. A buzzer can be sounded depending upon the model.

[Attribute]

-   -   drawer

(Option)

This attribute specifies the drawer kick-out connector. FIG. 50A showsthe attribute values.

-   -   time

(Option)

This attribute specifies the drawer kick-out signal ON time. FIG. 50Bshows the attribute values.

[Example] FIG. shows a sample XML document.

<sound>

This message sounds a buzzer.

[Attribute]

-   -   pattern

(Option)

This attribute specifies the buzzer pattern. FIG. 51A shows theattribute values.

-   -   repeat

(Optional, default: “1”)

This attribute specifies the number of times the buzzer sounds.

FIG. 51B shows the attribute values.

[Example] FIG. shows a sample XML document.

Message data for a customer display is described below.

Display data is described below in Customer Display Control XML.

<type>display</type>

[Request]

This message sends display data and setting data to the customerdisplay. FIG. 52A shows sub-elements.

[Example] FIG. 52B shows an example of a request.

<type>onxmlresult</type>

[Response]

This message returns the result of sending to the customer display tothe application. FIG. 53A shows the sub-element.

[Example] FIG. 53B shows an example of a response.

Customer Display Control XML, which is an XML document that controls acustomer display, is described next.

Message data for a customer display is described above under MessageData for the Customer Display.

<epos-display>

This is an XML document sent from the application to the customerdisplay. This document requests the customer display to execute thespecified function. An <epos-display> message contains sub-elementsrequired to control the customer display.

[Attribute]

-   -   xmlns

This attribute declares the name of the epos-display. FIG. 54A showssub-elements.

[Example] FIG. 54B shows a sample XML document.

<response>

This is an XML document returned from the customer display to theapplication.

[Attribute]

-   -   success

This attribute gets the display result. FIG. 55A shows the attributevalues.

-   -   code

This attribute gets the error code. FIG. 55B shows the attribute values.

-   -   status

This attribute is always set to 0.

[Example] FIG. 55C shows a sample XML document.

<window>

This message controls creating and deleting windows and moving thecurrent window.

-   -   This message creates the defined window when the number, x, y,        width, and height attributes are specified. Windows are defined        to not overlap with an already defined window. The window size        must be defined to fit in the customer display size (20        columns×2 rows).    -   The specifiedwindow is deleted if the number attribute is        defined and the destroy attribute is set to true.    -   If the number attribute is defined when the attributes to create        or delete a window are not defined, the current window moves to        the specified window position.        [Attribute]    -   number

This attribute specifies the number of the target window. FIG. 56 showsthe attribute values.

-   -   x

This attribute specifies the x-coordinate (1 to 20) as an integer tocreate a window.

-   -   y

This attribute specifies the y-coordinate (1 or 2) as an integer tocreate a window.

-   -   Width

This attribute specifies the width (1 to 20) as an integer to create awindow.

-   -   height

This attribute specifies the height (1 or 2) as an integer to create awindow.

-   -   scrollmode

This attribute specifies the scrolling method of the window when awindow is created. FIG. 57A shows the attribute values.

-   -   destroy

This attribute specifies whether or not to delete the window specifiedby the number attribute. FIG. 57B shows the attribute values.

[Error conditions]

When an error occurs, a value shown in FIG. 57C is returned.

[Example] FIG. 57D shows a sample XML document.

<text>

This message controls displaying a character string.

-   -   If x and y attributes are defined, text is displayed from the        specified cursor position.    -   If x and y attributes are not defined, text is displayed from        the current cursor position.        [Attribute]    -   x

This attribute specifies the x-coordinate (1 to 20) of the text displayas an integer.

-   -   y

This attribute specifies the y-coordinate (1 or 2) of the text displayas an integer.

-   -   reverse

This attribute specifies shading for the displayed characters. FIG. 58Ashows the attribute values.

-   -   lang

This attribute specifies the language of the text display. If omitted,the current setting is used. FIG. 58B shows the attribute values.

[Example] FIG. 58C shows a sample XML document.

<cursor>

This message controls the cursor position and display settings.

This message specifies the cursor coordinates in the display using the xand y attributes.

This message specifies the cursor position in the current window usingthe moveto attribute.

This message is ignored if x, y, and moveto attributes are all definedat the same time.

[Attribute]

-   -   x

This attribute specifies the x-coordinate (1 to 20) of the cursor as aninteger.

-   -   y

This attribute specifies the y-coordinate (1 or 2) of the cursor as aninteger.

-   -   moveto

This attribute specifies the cursor position in the current window. FIG.59A shows the attribute values.

-   -   type

This attribute specifies the display method of the cursor. If omitted,the current setting is used. FIG. 59B shows the attribute values.

[Example] FIG. 59C shows a sample XML document.

<blink>

This message controls screen blinking. Blinking continues at theinterval specified in the interval attribute.

The actual blinking interval is rounded up in 50 ms increments.

For example, if interval is 1 to 50, the actual interval is 50 ms; ifthe interval is 51 to 100, the actual interval is 100 ms.

[Attribute]

-   -   interval

This attribute specifies the blinking interval as an integer. FIG. 60Ashows the attribute values.

[Example] FIG. 60B shows a sample XML document.

<brightness>

This message controls the display brightness.

[Attribute]

-   -   value

This attribute specifies brightness as a percentage. FIG. 61A shows theattribute values.

[Example] FIG. 61B shows a sample XML document.

<marquee>

This message controls the marquee display of a character string.

The specified string is displayed 1 character at a time at the intervalspecified in uwait. After the string is displayed to the end, displaypauses for the time specified by rwait, and the string is then displayedagain from the beginning.

[Attribute]

-   -   format

This attribute specifies the display pattern for the marquee. FIG. 62Ashows the attribute values.

-   -   repeat

This attribute specifies how many times the marquee is displayed. FIG.62B shows the attribute values.

-   -   uwait

This attribute specifies the interval waited to display each characterin milliseconds. FIG. 62C shows the attribute values.

-   -   rwait

This attribute specifies how long to wait after the end of the string isdisplayed in milliseconds. FIG. 62D shows the attribute values.

-   -   lang

This attribute specifies display language. If omitted, the currentsetting is used. FIG. 62E shows the attribute values.

[Example] FIG. 62F shows a sample XML document.

<clock>

This message displays the time in the bottom right corner of thedisplay.

The displayed time is the local time managed by the OS of the printer 5.

[Example] FIG. 63 shows a sample XML document.

<clear>

This message clears the display of the current window.

If a window does not exist, the whole display is cleared.

[Example] FIG. 64 shows a sample XML document.

<reset>

This message resets the display. Resetting the display results in thefollowing.

-   -   All character strings are cleared, and all registered windows        are discarded.    -   The cursor returns to the default state and moves to the origin        of the display.    -   Display blinking and display brightness return to the default        settings.

[Example] FIG. 65 shows a sample XML document.

<command>

This message executes a desired ESC/POS command.

The desired command is specified by a hexadecimal string.

[Example] FIG. 66 shows a sample XML document.

Message Data for a POS Keyboard is described next.

<type>onkeypress</type>

[Response]

This message returns input data from a POS keyboard to the application.FIG. 67A shows sub-elements.

(Character strings in received data)

The character strings shown in FIG. 67B are escaped.

[Example] FIG. 67C shows an example of a response.

<type>setprefix</type>

This message specifies the key code used to determine the start of acharacter string to detect input from the POS keyboard. If a key codespecified by this message is input, the character string from then untilthe Enter key is pressed is returned in the onstring message.

This is used, for example, to substitute input from the POS keyboard forbarcode input. To stop the onstring message, send a setprefix messagewithout a keycode.

[Request]

This message specifies the key code used to determine the start of acharacter string to detect input from the POS keyboard. FIG. 68A showssub-elements.

[Example] FIG. 68B shows an example of a request.

<type>onstring</type>

[Response]

This message returns input data from the POS keyboard to theapplication.

This message reports detection of input from any one of the key codesspecified with setprefix to Enter. The detected key code information isacquired in the argument in addition to the input sequence ofcharacters. FIG. 69A shows sub-elements.

(Character Strings in the Received Data)

The strings shown in FIG. 69B are escaped.

[Example] FIG. 69C shows an example of a response.

Message Data for a Serial Device is described next.

<type>sendcommand</type>

[Request]

This message sends commands to the serial device. FIG. 70A showssub-elements.

[Example] FIG. 70B shows an example of a request.

<type>oncommandreply</type>

[Response]

This message returns data from the serial device to the application.FIG. 71A shows sub-elements.

-   -   status

FIG. 71B shows the attribute values.

[Example] FIG. 71C shows an example of a response.

The device control script 502 is described next.

Programming is described first.

FIG. 72 describes using a device control script.

By using the device control script API provided by the device controlfunction of the invention, data processing by a device can be customizedand new devices can be used from the application 31.

As shown in FIG. 72, a device control script 502 has a DeviceConnectionobject 503 and a ClientConnection object 504. In FIG. 81, devices of thehighly functional printer 5 are collectively represented by device 20.

When XML data (Request) containing the open_device message describedabove is sent, the socket interface 500 of the printer 5 receives theXML data. The socket interface 500 then passes the received data to thedevice service interface 501. The device service interface 501 theninstantiates an object so that the device control script correspondingto the device requested by the open_device message can be used. Thedevice 20 can then be controlled through the instantiated object.

[Device Control Script Object]

The objects shown in FIG. 73 are then passed to the device controlscript 502 from the device service interface 501. By using the deviceconnection (DeviceConnection) object 503 and client connection(ClientConnection) object 504, the device control script 502 cancommunicate with the application 31 and device 20.

Functions that use device control script objects are described next.

The following functions can be used using device control script APIs.

-   -   Desired events of application 31 side device objects can be        called.    -   Data can be sent to a device.    -   Generated data can be received from the device.

The configuration of a device control script is described next.

A device control script is coded to include the following conditions.

-   -   The code required for device control must be contained in a        single file.

(Only one file can be registered when configuring a device using theTMNetWebConfig utility.)

-   -   The part of the file name up to the first dot “.” and the        constructor name must be the same.

(Example) file name: Keyboard_Generic.ver1.0.js→constructor name:Keyboard_Generic

-   -   Declare exports to externally reference a constructor.

(Example) exports. Keyboard_Generic=Keyboard_Generic

-   -   The device control script must have the properties shown in FIG.        74 and FIG. 75. An appropriate name is set using constructor.

DEVICE_TYPE property (object type: String)

A list of settings is shown in FIG. 74.

DEVICE_GROUP property (object type: String)

A list of settings is shown in FIG. 75.

-   -   Create an “onDeviceData” method to receive data generated by the        device. For details, see the device control script Name object        described below.    -   Create a method corresponding to the device object method that        runs on the application 31. For details, refer to the Any event        described below.

FIG. 76 shows an example of the configuration of a sample device controlscript 502.

A list of device control script APIs is shown.

The following objects are provided in the device control script API.

-   -   ClientConnection object (The API list is shown in FIG. 77.)    -   DeviceConnection object (The API list is shown in FIG. 78.)    -   Device control script Name object (The API list is shown in FIG.        79.)

The ClientConnection object is described next.

This object is an object passed to the first parameter of theconstructor of the device control script 502.

-   -   send

This method sends data to a device object that runs on a browser.

[Syntax]

send (event, data);

[Parameters]

-   -   event: object type: (String)

This parameter specifies the event name of the device object.

-   -   data: object type: (Object)

This parameter specifies the data passed to the device object event.

An example is shown in FIG. 80. In this example, the onkeypress event ofthe device object is called, and 49 is received from data.keycode and 1is received from data.ascii using the data parameter of the onkeypressevent.

The DeviceConnection object is described next.

This object is an object passed in the second parameter of theconstructor of the device control script 502.

-   -   send

This method sends data to a serial communication device.

[Syntax]

send (data);

[Parameters]

data: object type: (Buffer)

This parameter specifies the data to send to the device.

The device control script Name object is described next.

-   -   onDeviceData event (input device that can operate with an HID        driver)

This event receives detected data from a key input device.

Events are described in this format in a device control script 502 for akey input device.

[Syntax]

onDeviceData (event, keycode, ascii);

[Parameters]

event: object type: (Number)

This parameter receives the direction of key operation. For a list ofvalues, see FIG. 81.

keycode: object type: (Number)

This parameter receives the key code. For a list of key codes, see FIG.3A and FIG. 3B.

ascii: object type: (String)

This parameter receives the character corresponding to the operated key.

If no character corresponds to the key code (such as with the F1 key),undefined is returned.

-   -   onDeviceData event (serial communication device)

This event receives data detected from a serial communication device.

Events are described in this format in a device control script 502 forserial communication.

[Syntax]

onDeviceData (data);

[Parameters]

-   -   data: object type: (Buffer)

This parameter receives data received from a serial communicationdevice.

-   -   Any event

This event receives the results of API execution by a device object thatruns on a browser.

[Syntax]

Name specified by callEvent (data);

[Parameters]

-   -   data: object type: (Object)

This parameter receives the object specified by the callEvent parameterof the device object.

A program is described next.

[Summary]

As shown in FIG. 82, this program provides the ability to read data withthe barcode scanner and print.

[Environment]

Devices

-   -   printer 5    -   barcode scanner 9

Execution Environment

The following environment is described here.

The work flow for building the program environment is shown in FIG. 83A.

1. Configure the network settings of the printer 5.

Configure the system and printer 5 network settings. The networksettings of the printer 5 can be configured using either of thefollowing methods.

-   -   Configure the Windows network settings on the printer 5.    -   Install the TMNet WinConfig utility on an external device        (Windows computer) to configure the settings.

2. Connect the barcode scanner 9 to the printer 5.

Connect the barcode scanner 9 to the printer 5.

3. Configure the barcode scanner

Register the barcode scanner 9 in the printer 5. Registration is donefrom a web browser.

[Configuring a Barcode Scanner]

Register a barcode scanner 9 to be controlled by Device XML in theprinter 5. The barcode scanner 9 is registered and configured using theTMNet WebConfig utility.

FIG. 94A shows an example of the TMNet WebConfig screen.

1. Confirm that the barcode scanner 9 is connected to the printer 5, andturn the printer 5 on.

2. Start the web browser on the computer used for configuring, and inputthe URL (http://IP address of printer 5/webconfig/).

3. The TMNetWebConfig utility starts. Click on [Web servicesettings]-[Device registration]-[Key input device] shown in (3) in FIG.94A.

4. The “Key input device” screen is displayed. Set the items shown inFIG. 94B in the input fields shown in (4) in FIG. 94A, and click[Registration].

5. The registered barcode scanner is displayed in the [Registered keyinput devices] field in (5) in FIG. 94A.

As described above, a device control system 100 according to thisembodiment of the invention has a terminal 3 that executes anapplication 31, and a printer 5 with a connection panel 60 to which adevice connects, connected over a network. The terminal 3 sends XML datagenerated by the application 31 to the printer 5. The printer 5 receivesthe XML data sent from the terminal 3 through a socket interface 500.When the terminal 3 sends data requesting administrator information, theprinter 5 sends the administrator information of the printer 5 to theterminal 3 using functions of a device service interface 501 and devicecontrol script 502. When the terminal 3 sends data requesting devicecontrol, the printer 5 controls the device. As a result, devicesconnected to the printer 5 can be controlled by a terminal 3 connectedto the network. The terminal 3 can be any device that can run anapplication that generates data written in XML. Because XML is highlyversatile, many different devices can be used as the terminal 3.Developing applications for the terminal 3 is also simple.

When the terminal 3 requests administrator information by sending datacontaining an <admin_info> message, the printer 5 returns XML dataincluding the administrator name and/or location stored by the printer 5to the terminal 3.

When the terminal 3 sends data including a device open request, theprinter 5 enables controlling the device, and when the terminal 3 sendsdata including a device close request, the printer 5 disables control ofthe controlled device.

The data generated by the application 31 also includes message data thatdiffers for each device connected to the printer 5, or message datacommon to devices.

When controlling a device requested by data, the printer 5 alsoinstantiates a DeviceConnection object that sends data to the device,and a ClientConnection object that sends data to the terminal 3.

The foregoing embodiment obviously describes one example of theinvention, and can be modified and adapted as desired within the scopeof the accompanying claims.

The invention claimed is:
 1. A point-of-sale printer for a point-of-sale(POS) system, the point-of-sale printer comprising: a first connectorconfigured to connect the point-of-sale printer to a device responsiveto device-control commands, the device being external to thepoint-of-sale printer; a second connector configured to communicate witha terminal, to receive a markup language request from the terminal, andto send a markup language response to the terminal, the terminal beingexternal to the point-of-sale printer; a controller configured tointerpret the markup language request received from the terminal, and tocontrol the device using appropriate device-control commands to executethe interpreted markup language request, the point-of-sale printer beingfurther configured to encode any response from the device as a markuplanguage response and to send the markup language response to theterminal; wherein the device-control commands are not a markup language.2. The point-of-sale printer described in claim 1, wherein the markuplanguage response includes data denoting a result of device control. 3.The point-of-sale printer described in claim 1, wherein when thepoint-of-sale printer receives from the terminal an establishcommunication markup language request to establishment a communicationlink with the point-of-sale printer, the point-of-sale printer sends tothe terminal a markup language response to the establish communicationmarkup language request.
 4. The point-of-sale printer described in claim1, wherein in response to the point-of-sale printer receiving from theterminal an open markup language request to open communication with thedevice connected to the point-of-sale printer, the point-of-sale printersends to the terminal a markup language response to the open markuplanguage request indicating whether a communication link with the deviceis established.
 5. The point-of-sale printer described in claim 1,wherein in response to the point-of-sale printer receiving from theterminal a close markup language request to close communication with thedevice, the point-of-sale printer sends to the terminal a markuplanguage response to the close markup language request indicatingwhether communication with the device is closed.
 6. The point-of-saleprinter described in claim 1, wherein the second connector is part of acomputer network interface to connect with the terminal over a computernetwork.